Closed Bug 1646272 Opened 5 years ago Closed 5 years ago

Consolidate existing docs on the Oxidation wiki and move them in-tree

Categories

(Core :: General, task)

task

Tracking

()

RESOLVED FIXED

People

(Reporter: n.nethercote, Assigned: n.nethercote)

References

(Depends on 1 open bug, Blocks 1 open bug)

Details

The Oxidation wiki page has a section containing some documentation about writing Rust code in Firefox. It's a real mish-mash, containing links to: in-tree docs, a dev-platform email thread, a wiki page, an MDN page, a slide deck, and a blog post.

This pieces of documentation should be consolidated, probably as in-tree docs because that seems to be the preferred approach nowadays. I'm not sure exactly what structure would be best... one the one hand, it would be nice to have all the info about writing Rust code in a single section. On the other hand, we already have separate sections for code, the build system, testing, etc., so perhaps I should split things up according to those sections, and then the Oxidation wiki could just have links to the relevant sections.

Blocks: rust-great
Depends on: 1646280
Depends on: 1646627
No longer depends on: 1646627
Depends on: 1428139
Depends on: 1647987
Depends on: 1648348

Bug 1428139 is still open but that could take a long time and the other blocking bugs are done, so I will close this.

Status: ASSIGNED → RESOLVED
Closed: 5 years ago
Resolution: --- → FIXED
Summary: Improve Rust-in-Firefox documentation → Consolidate existing docs on the Oxidation wiki and move them in-tree
You need to log in before you can comment on or make changes to this bug.